/**
 * Software License, Version 1.0
 * 
 * Copyright 2003 The Trustees of Indiana University.  All rights reserved.
 * 
 *
 *Redistribution and use in source and binary forms, with or without 
 *modification, are permitted provided that the following conditions are met:
 *
 *1) All redistributions of source code must retain the above copyright notice,
 * the list of authors in the original source code, this list of conditions and
 * the disclaimer listed in this license;
 *2) All redistributions in binary form must reproduce the above copyright 
 * notice, this list of conditions and the disclaimer listed in this license in
 * the documentation and/or other materials provided with the distribution;
 *3) Any documentation included with all redistributions must include the 
 * following acknowledgement:
 *
 *"This product includes software developed by the Community Grids Lab. For 
 * further information contact the Community Grids Lab at 
 * http://communitygrids.iu.edu/."
 *
 * Alternatively, this acknowledgement may appear in the software itself, and 
 * wherever such third-party acknowledgments normally appear.
 * 
 *4) The name Indiana University or Community Grids Lab or NaradaBrokering, 
 * shall not be used to endorse or promote products derived from this software 
 * without prior written permission from Indiana University.  For written 
 * permission, please contact the Advanced Research and Technology Institute 
 * ("ARTI") at 351 West 10th Street, Indianapolis, Indiana 46202.
 *5) Products derived from this software may not be called NaradaBrokering, 
 * nor may Indiana University or Community Grids Lab or NaradaBrokering appear
 * in their name, without prior written permission of ARTI.
 * 
 *
 * Indiana University provides no reassurances that the source code provided 
 * does not infringe the patent or any other intellectual property rights of 
 * any other entity.  Indiana University disclaims any liability to any 
 * recipient for claims brought by any other entity based on infringement of 
 * intellectual property rights or otherwise.  
 *
 *LICENSEE UNDERSTANDS THAT SOFTWARE IS PROVIDED "AS IS" FOR WHICH NO 
 *WARRANTIES AS TO CAPABILITIES OR ACCURACY ARE MADE. INDIANA UNIVERSITY GIVES
 *NO WARRANTIES AND MAKES NO REPRESENTATION THAT SOFTWARE IS FREE OF 
 *INFRINGEMENT OF THIRD PARTY PATENT, COPYRIGHT, OR OTHER PROPRIETARY RIGHTS. 
 *INDIANA UNIVERSITY MAKES NO WARRANTIES THAT SOFTWARE IS FREE FROM "BUGS", 
 *"VIRUSES", "TROJAN HORSES", "TRAP DOORS", "WORMS", OR OTHER HARMFUL CODE.  
 *LICENSEE ASSUMES THE ENTIRE RISK AS TO THE PERFORMANCE OF SOFTWARE AND/OR 
 *ASSOCIATED MATERIALS, AND TO THE PERFORMANCE AND VALIDITY OF INFORMATION 
 *GENERATED USING SOFTWARE.
 */
package cgl.narada.service.reliable;

import cgl.narada.matching.Profile;
import cgl.narada.service.Service;
import cgl.narada.service.ServiceException;
import cgl.narada.service.qos.ConsumerConstraints;
import cgl.narada.service.qos.QosEvent;
import cgl.narada.service.reliable.events.RdArchivalServiceNotification;
import cgl.narada.service.reliable.events.RdProfileUpdateResponse;
import cgl.narada.service.reliable.events.RdRecoveryEntityRequest;
import cgl.narada.service.reliable.events.RdRecoveryResponse;
import cgl.narada.service.reliable.events.RdRetransmissionServiceEvent;

/** This class provides a set of core functions that service implementations
    need to satisfy. All services within the system need to conform to this
    interface. 

    @author Shrideep Pallickara
    $Date$
    $Revision$
*/

public interface RdEntityActuatorService extends Service {
  
  public void 
  processRetransmittedEvent(RdRetransmissionServiceEvent retransmittedEvent) 
    throws ServiceException;
  
  /** Upong receipt of a NORMAL nbEvent, the qosService constructs a QosEvent
      if there were any consumerConstraints specified. This event is then
      routed here pending satisfaction of consumer constraints */  
  public void processConstructedQosEvent(QosEvent qosEvent) 
    throws ServiceException;

  
  
  public void
  syncPointHasBeenAdvanced(int entityId, int templateId, long advanceSync);


  public void 
  processArchivalNotificationForEntity(Object entityKey,
		RdArchivalServiceNotification archNotification) 
    throws ServiceException;
  
  public void issueRecoveryRequest(RdRecoveryEntityRequest recoveryRequest)
    throws ServiceException;

  /** Subscribe the relevant consumer to the set of previously registered 
      profiles based on information encapsulated in the recovery response*/
  public void processRecoveryResponse(RdRecoveryResponse recoveryResponse)
    throws ServiceException;
  
  
  public void 
  issueProfileUpdateRequest(Profile profile, boolean addProfile,
			    ConsumerConstraints consumerConstraints) 
    throws ServiceException;


  public void 
  processProfileUpdateResponse(RdProfileUpdateResponse profileUpdateResponse) 
    throws ServiceException;


  /** Terminate the service */
  public void terminateService() throws ServiceException;
}
